<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>ARWrapper: ARPattern Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">ARWrapper
   </div>
   <div id="projectbrief">Provides a C++ wrapper around ARToolKit and exposes a C and JNI API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_a_r_pattern-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ARPattern Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Encapsulates information about a sub-component of a marker useful for presentation to a user.  
 <a href="class_a_r_pattern.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_a_r_pattern_8h_source.html">ARPattern.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a490d2397b82a58c44eaa88a9c33172ba"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a490d2397b82a58c44eaa88a9c33172ba">PATTERN_TYPE</a> { <a class="el" href="class_a_r_pattern.html#a490d2397b82a58c44eaa88a9c33172baaef06318897487cc600d1737885584d71">PATTERN_TYPE_NONE</a> = 0, 
<a class="el" href="class_a_r_pattern.html#a490d2397b82a58c44eaa88a9c33172baa44648dfa666ba8e0f4d9097089ec2bca">PATTERN_TYPE_TEMPLATE</a>, 
<a class="el" href="class_a_r_pattern.html#a490d2397b82a58c44eaa88a9c33172baa8a7029259f8c27c1d84ec3c74eae9034">PATTERN_TYPE_MATRIX</a>, 
<a class="el" href="class_a_r_pattern.html#a490d2397b82a58c44eaa88a9c33172baaa3d7bd17c224ab413b259c36e2443e71">PATTERN_TYPE_ISET</a>
 }</td></tr>
<tr class="separator:a490d2397b82a58c44eaa88a9c33172ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1b51726a1360db13e162988fcc758903"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a1b51726a1360db13e162988fcc758903">ARPattern</a> ()</td></tr>
<tr class="separator:a1b51726a1360db13e162988fcc758903"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a052cbe823a81cc1209b10501c38dcb2a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a052cbe823a81cc1209b10501c38dcb2a">~ARPattern</a> ()</td></tr>
<tr class="separator:a052cbe823a81cc1209b10501c38dcb2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b3fa362244a54588d361af8c09690f6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a6b3fa362244a54588d361af8c09690f6">loadTemplate</a> (int patternID, const ARPattHandle *arPattHandle, float width)</td></tr>
<tr class="separator:a6b3fa362244a54588d361af8c09690f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a214920151785182893dafc208fcb4628"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a214920151785182893dafc208fcb4628">loadMatrix</a> (int barcodeID, AR_MATRIX_CODE_TYPE type, float width)</td></tr>
<tr class="separator:a214920151785182893dafc208fcb4628"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a784ad52cd61c7fb11f0dbbdf652218d3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a784ad52cd61c7fb11f0dbbdf652218d3">loadISet</a> (const AR2ImageSetT *imageSet, float nftScale)</td></tr>
<tr class="separator:a784ad52cd61c7fb11f0dbbdf652218d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0bcdf76b85f6dcda81828df5855006d7"><td class="memItemLeft" align="right" valign="top">ARdouble&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a0bcdf76b85f6dcda81828df5855006d7">m_matrix</a> [16]</td></tr>
<tr class="memdesc:a0bcdf76b85f6dcda81828df5855006d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transform of the pattern from origin.  <a href="#a0bcdf76b85f6dcda81828df5855006d7">More...</a><br/></td></tr>
<tr class="separator:a0bcdf76b85f6dcda81828df5855006d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a014e8b4f193cb5f1f6e391952d9d93be"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a014e8b4f193cb5f1f6e391952d9d93be">m_width</a></td></tr>
<tr class="memdesc:a014e8b4f193cb5f1f6e391952d9d93be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width of the pattern in mm.  <a href="#a014e8b4f193cb5f1f6e391952d9d93be">More...</a><br/></td></tr>
<tr class="separator:a014e8b4f193cb5f1f6e391952d9d93be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8569746e86c1f87931f4cc0cc76ccb1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#aa8569746e86c1f87931f4cc0cc76ccb1">m_height</a></td></tr>
<tr class="memdesc:aa8569746e86c1f87931f4cc0cc76ccb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Height of the pattern in mm.  <a href="#aa8569746e86c1f87931f4cc0cc76ccb1">More...</a><br/></td></tr>
<tr class="separator:aa8569746e86c1f87931f4cc0cc76ccb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac22f3b642fb9e8d082205a00fee755b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#aac22f3b642fb9e8d082205a00fee755b">m_imageSizeX</a></td></tr>
<tr class="separator:aac22f3b642fb9e8d082205a00fee755b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e5bab855b3f821990972ee4f7daf9f3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#a0e5bab855b3f821990972ee4f7daf9f3">m_imageSizeY</a></td></tr>
<tr class="separator:a0e5bab855b3f821990972ee4f7daf9f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec1d430d00d9b2d1db8b5a91cd2d7c1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_color.html">Color</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_r_pattern.html#aec1d430d00d9b2d1db8b5a91cd2d7c1e">m_image</a></td></tr>
<tr class="memdesc:aec1d430d00d9b2d1db8b5a91cd2d7c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image of the pattern.  <a href="#aec1d430d00d9b2d1db8b5a91cd2d7c1e">More...</a><br/></td></tr>
<tr class="separator:aec1d430d00d9b2d1db8b5a91cd2d7c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encapsulates information about a sub-component of a marker useful for presentation to a user. </p>
<p>For a single square marker, there will be one pattern per marker. For a multimarker (multiple square markers), there will be one or more patterns per marker.</p>
<p>Currently, the encapsulated information is the pose relative to the marker origin, and (for template markers only) the visual appearance of the pattern. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a490d2397b82a58c44eaa88a9c33172ba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_a_r_pattern.html#a490d2397b82a58c44eaa88a9c33172ba">ARPattern::PATTERN_TYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a490d2397b82a58c44eaa88a9c33172baaef06318897487cc600d1737885584d71"></a>PATTERN_TYPE_NONE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a490d2397b82a58c44eaa88a9c33172baa44648dfa666ba8e0f4d9097089ec2bca"></a>PATTERN_TYPE_TEMPLATE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a490d2397b82a58c44eaa88a9c33172baa8a7029259f8c27c1d84ec3c74eae9034"></a>PATTERN_TYPE_MATRIX</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a490d2397b82a58c44eaa88a9c33172baaa3d7bd17c224ab413b259c36e2443e71"></a>PATTERN_TYPE_ISET</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1b51726a1360db13e162988fcc758903"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ARPattern::ARPattern </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a052cbe823a81cc1209b10501c38dcb2a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ARPattern::~ARPattern </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a784ad52cd61c7fb11f0dbbdf652218d3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ARPattern::loadISet </td>
          <td>(</td>
          <td class="paramtype">const AR2ImageSetT *&#160;</td>
          <td class="paramname"><em>imageSet</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>nftScale</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a214920151785182893dafc208fcb4628"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ARPattern::loadMatrix </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>barcodeID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">AR_MATRIX_CODE_TYPE&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>width</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a6b3fa362244a54588d361af8c09690f6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ARPattern::loadTemplate </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>patternID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const ARPattHandle *&#160;</td>
          <td class="paramname"><em>arPattHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>width</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa8569746e86c1f87931f4cc0cc76ccb1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ARPattern::m_height</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Height of the pattern in mm. </p>

</div>
</div>
<a class="anchor" id="aec1d430d00d9b2d1db8b5a91cd2d7c1e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_color.html">Color</a>* ARPattern::m_image</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Image of the pattern. </p>

</div>
</div>
<a class="anchor" id="aac22f3b642fb9e8d082205a00fee755b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ARPattern::m_imageSizeX</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a0e5bab855b3f821990972ee4f7daf9f3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ARPattern::m_imageSizeY</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a0bcdf76b85f6dcda81828df5855006d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ARdouble ARPattern::m_matrix[16]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Transform of the pattern from origin. </p>

</div>
</div>
<a class="anchor" id="a014e8b4f193cb5f1f6e391952d9d93be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ARPattern::m_width</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Width of the pattern in mm. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/ARWrapper/<a class="el" href="_a_r_pattern_8h_source.html">ARPattern.h</a></li>
<li>lib/SRC/ARWrapper/<a class="el" href="_a_r_pattern_8cpp.html">ARPattern.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 23 2016 17:24:25 for ARWrapper by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
